Obsidian Markdown Guide

useful shortcuts

Ctrl + N: new note
Ctrl + E: toggle edit mode
Ctrl + enter: toggle checkbox
Ctrl + shift + F: search among all files
Ctrl + P: command panel
Ctrl + [ or ] : change indentation of a list item
Alt + click to make multiple cursors

Internal linking

Link to a page: [[Internal link]].

Link to a page: [[Internal link]].

Embeds

Embed another file (read more about [[Embed files]]). Here's an embedded section:

![[Obsidian#What is Obsidian]]

![[Obsidian#What is Obsidian]]

Headers

# This is a heading 1
## This is a heading 2
### This is a heading 3 
#### This is a heading 4
##### This is a heading 5
###### This is a heading 6

This is a heading 1

This is a heading 2

This is a heading 3

This is a heading 4

This is a heading 5

This is a heading 6

Emphasis

*This text will be italic*
_This will also be italic_

This text will be italic This will also be italic

**This text will be bold**
__This will also be bold__

This text will be bold This will also be bold

_You **can** combine them_

You can combine them

text `Inline Code` text		
~~Mistaken text.~~	
<ins>Underline</ins>

text Inline Code text ~~Mistaken text.~~ Underline

<center>This text is centered.</center>
<p style="text-align:center">Center this text</p>
<font color="red">This text is red!</font>
<p style="color:blue">Make this text blue.</p>
[This is a comment that will be hidden.]: # 
:warning: **Warning:** Do not push the big red button.
> :warning: **Warning:** Do not push the big red button.

More emojis: https://gist.github.com/rxaviers/7360908

Highlighting

Use two equal signs to ==highlight text==.

Use two equal signs to ==highlight text==.

Lists

+ Item 1
+ Item 2
  + Item 2a
  - Item 2b
  - Item 2c

Tasks
- [ ] a task list item
- [ ] incomplete
- [x] completed

1. Item 1
2. Item 2
3. Item 3
   4. Item 3a
   5. Item 3b

Item 1
Item 2
- Item 2a
- Item 2b
- Item 2c

Tasks

[ ] a task list item
[ ] incomplete
[x] completed

Item 1
Item 2
Item 3 4. Item 3a 5. Item 3b

Images

![Engelbart](https://history-computer.com/ModernComputer/Basis/images/Engelbart.jpg)

Engelbart

Resizing images

Example of this above image resized to 100 pixels wide:

![Engelbart|100](https://history-computer.com/ModernComputer/Basis/images/Engelbart.jpg)

Engelbart|100

Reference style

Reference-style: 
![alt text][logo]

[logo]: https://history-computer.com/ModernComputer/Basis/images/Engelbart.jpg "Logo Title Text 2"

Reference-style: alt text

With caption

<figure>
    <img src="https://www.markdownguide.org/assets/images/albuquerque.jpg"
         alt="Albuquerque, New Mexico">
    <figcaption>A single track trail outside of Albuquerque, New Mexico.</figcaption>
</figure>

Links

External links

Markdown style links can be used to refer to either external objects, such as web pages, or an internal page or image.

http://obsidian.md - automatic!
[Obsidian](http://obsidian.md)

http://obsidian.md - automatic! Obsidian

Obsidian URI links

[[Using obsidian URI|Obsidian URI]] links can be used to open notes in Obsidian either from another Obsidian vault or another program.

For example, you can link to a file in a vault like so (please note the [[Using obsidian URI#Encoding|required encoding]]):

[Link to note](obsidian://open?path=D:%2Fpath%2Fto%2Ffile.md)

Link to note

You can link to a note by its vault name and file name instead of path as well:

[Link to note](obsidian://open?vault=MainVault&file=MyNote.md)

Link to note

Reference Links

[You can use numbers for reference-style link definitions][1]

Or leave it empty and use the [link text itself][]

[1]: http://slashdot.org
[link text itself]: http://www.reddit.com

You can use numbers for reference-style link definitions

Or leave it empty and use the link text itself

Escaping

If there are spaces in the url, they can be escaped by either using %20 as a space, such as:

[Export options](Pasted%20image)

Export options

Or you can enclose the target in <>, such as:

[Slides Demo](<Slides Demo>)

Slides Demo

Videos

Copy the iframe of youtube and paste it

or...

They can't be added directly but you can add an image with a link to the video like this:

<a href="http://www.youtube.com/watch?feature=player_embedded&v=YOUTUBE_VIDEO_ID_HERE
" target="_blank"><img src="http://img.youtube.com/vi/YOUTUBE_VIDEO_ID_HERE/0.jpg" 
alt="IMAGE ALT TEXT HERE" width="240" height="180" border="10" /></a>

Or, in pure Markdown, but losing the image sizing and border:
[![IMAGE ALT TEXT HERE](http://img.youtube.com/vi/YOUTUBE_VIDEO_ID_HERE/0.jpg)](http://www.youtube.com/watch?v=YOUTUBE_VIDEO_ID_HERE)

Or, in pure Markdown, but losing the image sizing and border:

Blockquotes

> Human beings face ever more complex and urgent problems, and their effectiveness in dealing with these problems is a matter that is critical to the stability and continued progress of society.

\- Doug Engelbart, 1961

Human beings face ever more complex and urgent problems, and their effectiveness in dealing with these problems is a matter that is critical to the stability and continued progress of society.

- Doug Engelbart, 1961

Inline code

Text inside `backticks` on a line will be formatted like code.

Text inside backticks on a line will be formatted like code.

Code blocks

Syntax highlight is supported with the language specified after the first set of backticks. We use prismjs for syntax highlighting, a list of supported languages can be found at their site

function fancyAlert(arg) {
  if(arg) {
    $.facebox({div:'#foo'})
  }
}

    Text indented with a tab is formatted like this, and will also look like a code block in preview.

Text indented with a tab is formatted like this, and will also look like a code block in preview.

Tables

You can create tables by assembling a list of words and dividing them with hyphens - (for the first row), and then separating each column with a pipe |:

First Header | Second Header
------------ | ------------
Content from cell 1 | Content from cell 2
Content in the first column | Content in the second column

First Header | Second Header ------------ | ------------ Content from cell 1 | Content from cell 2 Content in the first column | Content in the second column

Tables can be justified with a colon | Another example with a long title
:----------------|-------------:
because of the `:` | these will be justified

If you put links in tables, they will work, but if you use Piped Links, the pipe must be escaped with a `\` to prevent it being read as a table element.

Tables can be justified with a colon | Another example with a long title :----------------|-------------: because of the : | these will be justified

If you put links in tables, they will work, but if you use Piped Links, the pipe must be escaped with a \ to prevent it being read as a table element.

First Header | Second Header
------------ | ------------
[[Format your notes\|Formatting]]	|  [[Keyboard shortcuts\|hotkeys]]

First Header | Second Header ------------ | ------------ [[Format your notes|Formatting]] | [[Use hotkeys|hotkeys]]

Footnotes

Here's a simple footnote,[^1] and here's a longer one.[^bignote]

[^1]: meaningful!

[^bignote]: Here's one with multiple paragraphs and code.

    Indent paragraphs to include them in the footnote.

    `{ my code }`

    Add as many paragraphs as you like.

Here's a simple footnote,^1 and here's a longer one.[^bignote]

[^bignote]: Here's one with multiple paragraphs and code.

Indent paragraphs to include them in the footnote.

`{ my code }`

Add as many paragraphs as you like.

You can also use inline footnotes. ^[notice that the carat goes outside of the brackets on this one.]

You can also use inline footnotes. ^[notice that the carat goes outside of the brackets on this one.]

Math

$$\begin{vmatrix}a & b\\
c & d
\end{vmatrix}=ad-bc$$

$$\begin{vmatrix}a & b\ c & d \end{vmatrix}=ad-bc$$

You can also do inline math like $e^{2i\pi} = 1$ .

Obsidian uses Mathjax. You can check which packages are supported in Mathjax here.

Comments

Use %% to enclose comments, which will be parsed as Markdown, but will not show up in the preview.

Here is some inline comments: %%You can't see this text%% (Can't see it)

Here is a block comment:
%%
It can span
multiple lines
%%

Here is some inline comments: %%You can't see this text%% (can't see it in preview)

Here is a block comment: (can't see it in preview either) %% It can span multiple lines %%

Diagram

Obsidian uses Mermaid to render diagrams and charts. Mermaid also provides a helpful live editor.

sequenceDiagram
    Alice->>+John: Hello John, how are you?
    Alice->>+John: John, can you hear me?
    John-->>-Alice: Hi Alice, I can hear you!
    John-->>-Alice: I feel great!

Obsidian supports linking to notes in Mermaid:

An easier way to do it is the following: ^376b9d

This way, all the note names (at least until Z[note name]) are all automatically assigned the class internal-link when you use this snippet.

If you use special characters in your note names, you need to put the note name in double quotes. "⨳ special character" It looks like this if you follow the [[Format your notes#^376b9d|second option]]: A["⨳ special character"]